/**
 * Copyright (C) 2008 GeoScheduler Team, as stated on <http://www.geoscheduler.org/authors>.
 * 
 * This file is part of GeoScheduler.
 * 
 * GeoScheduler is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * GeoScheduler is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with GeoScheduler. If not, see <http://www.gnu.org/licenses/>.
 */

package org.geoscheduler.commons.marshaller;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * 
 * <h2>JSONField</h2>
 * <p>
 * Annotation declaring that annotated field should be marshalled/unmarshalled
 * by {@link JSONMarshaller} implementation.
 * </p>
 * 
 * @author LKo (Lukas.Kolisko@Geoscheduler.Org)
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface JSONField {

	/** name for field in JSON object notation */
	String value() default "";
	
	/** serialized representation of default value of field */
	String defaultValue() default "";

	/** custom marshaling factory declaration */
	Class<JSONFieldDeclFactory> factory() default JSONFieldDeclFactory.class;

	/** force <code>null</code> as default value */
	boolean Null() default false;

	/**
	 * definition of element type for collections. Type will be
	 * used for creating instances in unmarshaling process.
	 */
	Class<?> elementType() default Object.class;

}
